Skip to content

SK-2142 return None in case of empty error for Data APIs and include file path in deidentify file request #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
raushan-skyflow merged 2 commits into from
Jul 8, 2025
Merged

SK-2142 return None in case of empty error for Data APIs and include file path in deidentify file request #188

raushan-skyflow merged 2 commits into from
Jul 8, 2025

Conversation

@raushan-skyflow
Copy link
Contributor

@raushan-skyflow raushan-skyflow commented Jul 8, 2025

This PR introduces enhancements to the Python SDK V2 for the deidentify_file functionality. It includes updates to both request and response formats for better consistency with other server-side SDKs (e.g., Node SDK V2). Additionally, it refines error handling to return None instead of an empty array when there are no errors.

Why:

  • Included file_path in the deidentify file request for deidentification ensuring consistency.
  • Added file_base64 in the response that holds the base64 of the deidentified file so users can directly access the deidentified file.
  • Updated the errors field to return None when no errors are present, matching the latest behavior of the Node SDK V2 and other server-side SDKs.

Goal:

  • Ensure the deidentify file request takes file_path and returns the file object.
  • Maintain consistency in response structure across SDKs by setting errors to None instead of an empty list when there are no errors.

Test:

  • Validated changes locally.
  • Added and ran unit tests to confirm correct behaviour of the new request/response structure and error handling.

raushan-skyflow and others added 2 commits July 4, 2025 12:17
@raushan-skyflow
Release/25.6.2 (#187)
3a6210b 
* SK-2139 return file object in deidentify file response , None on empty error response (#185)
@raushan-skyflow
[AUTOMATED] Public Release - 2.0.0b7
7598d9b
@raushan-skyflow raushan-skyflow changed the title Beta release/25.6.2 release/25.6.2 Jul 8, 2025
@raushan-skyflow raushan-skyflow changed the title release/25.6.2 SK-2142 return None in case of empty error for Data APIs and include file path in deidentify file request & includes both the file object and the file’s base64 content in Deidentify file response Jul 8, 2025
@raushan-skyflow raushan-skyflow changed the title SK-2142 return None in case of empty error for Data APIs and include file path in deidentify file request & includes both the file object and the file’s base64 content in Deidentify file response SK-2142 return None in case of empty error for Data APIs and include file path in deidentify file request Jul 8, 2025
@raushan-skyflow raushan-skyflow merged commit e3279f0 into v2 Jul 8, 2025
3 of 4 checks passed
skyflow-bharti pushed a commit that referenced this pull request Nov 18, 2025
@skyflow-vivek @saileshwar-skyflow
@amith-skyflow @raushan-skyflow
SK-2392 Migrate V2 code into main branch (#219)
c83a155 
* SK-1772: Beta Release for Python SDK V2 (#151)

* SK-1772: Beta Release for Python SDK V2

* SK-1772: Update beta release workflow

* SK-1772: Update beta release workflow

* SK-1772: Updated beta release workflow file

* SK-1772: Updated beta release workflow file

* SK-1772: Updated beta release workflow file

* SK-1772: Updated beta release workflow file

* SK-1772: Refactored workflows

* SK-1821: Refactor release pipelines (#153)

* SK-1821: Refactor release pipelines

* SK-1863: Added a migration guide section in the README for transitioning from v1 to v2. (#155)

* SK-1863: Added migration from v1 to v2 section in readme

* SK-1894: Update README for Python SDK V2 (#157)

* SK-1894: Update readme

* SK-1906 Improve debugging in connections

* SK-1906: Fix invoke connection test case

* SK-1934 Fix inconsistent error handling for invoke connections

* SK-1874: Support for the combination of tokens and redaction type in detokenize API (#164)

* SK-1874: Support for the combination of tokens and redaction type in the Detokenize API. (#156)

* [AUTOMATED] Private Release 2.0.0b1.dev0+3d4ee51

* SK-1772: Update enums (#167)

* SK-1908: Migrate Python SDK from openapi generator to Fern SDK generator (#168)

* SK-1908: Migrate from openapi generator to Fern

* [AUTOMATED] Private Release 2.0.0b2.dev0+f760bc0

* SK-2003: update readme

* SK-1909 Update generated code

* SK-1909 Handle API error cases after fern migration

* SK-1909 Update fern generated code

* SK-1909 Handle invalid cluster ID error scenario

* SK-1909 Fix inconsistencies and issues in Python SDK v2

* SK-1909 Fix issues in Python SDK v2
- Fix inconsistent response structure for invoke connection
- Fix 404 Not found error for get by column values
- Fix failing unit tests due to code changes

* [AUTOMATED] Private Release 2.0.0b2.dev0+3a80017

* SK-1909 Update sample to trigger release

* SK-1909 Trigger internal release

* [AUTOMATED] Private Release 2.0.0b2.dev0+3d817ab

* SK-1911: add sky metadata headers

* [AUTOMATED] Private Release 2.0.0b2.dev0+1816a92

* SK-1911: add sky metadata header constant

* [AUTOMATED] Private Release 2.0.0b2.dev0+6254896

* [AUTOMATED] Public Release - 2.0.0b3

* SK-2068: Detect Support in Python SDK. (#184)

* SK-2048: Detect Support

* SK-2142 return None in case of empty error for Data APIs and include file path in deidentify file request (#188)

* SK-2199: Update Python SDK v2 with latest Detect API changes (v4.0) (#190)

* SK-2199: Update Python SDK v2 with latest Detect API changes (v4.0) (#189)

* [AUTOMATED] Public Release - 2.1.0b1

* SK-971 file upload support (#191)

* SK-971 file upload support

* [AUTOMATED] Private Release 2.1.0b1.dev0+61e368f

* SK-2270 fix inconsistencies in python SDK V2 (#193)

* SK-2270: fix inconsistencies in python SDK V2

* [AUTOMATED] Private Release 1.15.4.dev0+8e1d653

* SK-2270: revert the fern generated detect changes (#201)

* [AUTOMATED] Private Release 1.15.5.dev0+dab7b66

* SK-2353: Update generated code with updated openapi spec file. (#211)

* SK-2353: update generated code with updated openapi spec file

* [AUTOMATED] Private Release 1.15.8.dev0+08b535a

* SK-2353: fix indentation

* [AUTOMATED] Private Release 1.15.8.dev0+4c27775

* SK-2385: add locations to the generated code

* [AUTOMATED] Private Release 1.15.8.dev0+ba73553

* SK-2385: update output transcriptions enum

* [AUTOMATED] Private Release 1.15.8.dev0+3e794e3

* SK-1773 Add str for file upload response

* [AUTOMATED] Private Release 1.15.8.dev0+a22b9c6

* [AUTOMATED] Public Release - 2.0.0

* SK-1773 Dummy change to trigger release

* SK-1773 Update release workflow

* [AUTOMATED] Public Release - 2.0.0

* SK-2392 Add sample and update README for upload file

---------

Co-authored-by: saileshwar-skyflow <156889717+saileshwar-skyflow@users.noreply.github.com>
Co-authored-by: saileshwar-skyflow <saileshwar.bogam@skyflow.com>
Co-authored-by: skyflow-vivek <skyflow-vivek@users.noreply.github.com>
Co-authored-by: saileshwar-skyflow <saileshwar-skyflow@users.noreply.github.com>
Co-authored-by: “amith-skyflow” <“amit@skyflow.com”>
Co-authored-by: amith-skyflow <168510106+amith-skyflow@users.noreply.github.com>
Co-authored-by: raushan-skyflow <raushan.gupta@skyflow.com>
Co-authored-by: raushan-skyflow <raushan-skyflow@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@saileshwar-skyflow saileshwar-skyflow saileshwar-skyflow approved these changes

+1 more reviewer

@skyflow-shravan skyflow-shravan skyflow-shravan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@raushan-skyflow @skyflow-shravan @saileshwar-skyflow